Skip to content

[guide] docs: env-vars.md — add 7 missing operator-facing variables (workspace cleanup, advisory thresholds, hub public-origin chain) - #5740

Merged
clubanderson merged 1 commit into
v4from
guide/docs-env-vars-missing
Sep 3, 2026
Merged

[guide] docs: env-vars.md — add 7 missing operator-facing variables (workspace cleanup, advisory thresholds, hub public-origin chain)#5740
clubanderson merged 1 commit into
v4from
guide/docs-env-vars-missing

Conversation

@kubestellar-hive

@kubestellar-hive kubestellar-hive Bot commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

Documentation Fix

Adds the 7 undocumented operator-facing environment variables from #5739 to src/docs/env-vars.md, in the sections matching the components that read them:

Core runtime (src/pkg/dashboard/workspace_cleanup.go):

  • HIVE_WORKSPACE_CLEANUP_INTERVAL (default 1h) and HIVE_WORKSPACE_CLEANUP_MAX_AGE (default 2h) — Go durations; unset/unparseable/non-positive fall back to defaults.

Hub, SaaS, alerts, and backups:

  • HIVE_ADVISORY_ISSUE_AGING_AFTER (default 24h) and HIVE_ADVISORY_ISSUE_STALE_AFTER (default 72h) from src/pkg/hub/advisory_issue_activity.go, including the guard where stale ≤ aging silently reverts both to defaults.
  • HIVE_HUB_PUBLIC_URL, HIVE_PUBLIC_URL, HIVE_HUB_BASE_URL — the hub public-origin chain (src/pkg/hub/access_notify.go:29, src/pkg/hub/url_reachability.go:219) with its full 5-variable precedence order, plus chain-role notes on the existing HIVE_DASHBOARD_URL and HIVE_HUB_URL rows.

Verified: go test ./pkg/config/ -run TestEnvVarsDocDocumentsOnlyRealVariables passes (every added row names a variable the code reads).

Scope claimed: src/docs/env-vars.md only. Disjoint from open PRs #5737 (tests), #5717 (CI script), #5697 (pkg/hub wrapkey code), #5642 (ADOPTERS.md), #5635 (docs/rfc-4002), #5559 (UPGRADE.md), #4032 (proxy).

Fixes #5739

Filed by guide agent (ACMM L5 — hold-gated mode). Hold-gated: human review required.

— hive: agent=guide backend=copilot model=claude-sonnet-4-6

hive-guide
[guide] docs: env-vars.md — add 7 missing operator-facing variables
7efcddf 
Adds rows for HIVE_WORKSPACE_CLEANUP_INTERVAL and
HIVE_WORKSPACE_CLEANUP_MAX_AGE (workspace_cleanup.go tuning knobs),
HIVE_ADVISORY_ISSUE_AGING_AFTER and HIVE_ADVISORY_ISSUE_STALE_AFTER
(advisory issue-activity thresholds, incl. the stale<=aging revert
guard), and HIVE_HUB_PUBLIC_URL / HIVE_PUBLIC_URL / HIVE_HUB_BASE_URL
(hub public-origin chain), and notes the chain role of the already
documented HIVE_DASHBOARD_URL and HIVE_HUB_URL.

Refs #5739

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Signed-off-by: hive-guide <sec-check@hive.kubestellar.io>
@kubestellar-hive kubestellar-hive Bot added the hold label Sep 2, 2026
@kubestellar-prow kubestellar-prow Bot added the dco-signoff: yes Indicates the PR's author has signed the DCO. label Sep 2, 2026
@kubestellar-prow

kubestellar-prow Bot commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign hanthor for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@kubestellar-prow kubestellar-prow Bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Sep 2, 2026
@kubestellar-hive kubestellar-hive Bot mentioned this pull request Sep 2, 2026
Closed
clubanderson
clubanderson approved these changes Sep 3, 2026
View reviewed changes

@clubanderson clubanderson left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed env-var docs against the code paths that read each variable. Defaults/precedence match workspace_cleanup.go, advisory_issue_activity.go, access_notify.go/url_reachability.go, main.go, and the TUI client constants. Documentation-only change; go build ./... passes.

@kubestellar-prow kubestellar-prow Bot added the lgtm Indicates that a PR is ready to be merged. label Sep 3, 2026
@kubestellar-prow

kubestellar-prow Bot commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

LGTM label has been added.

DetailsGit tree hash: c6212e99d95a816fec6a38999cdb779680a268f1

@clubanderson
clubanderson merged commit 6383176 into v4 Sep 3, 2026
59 of 61 checks passed
@kubestellar-prow
kubestellar-prow Bot deleted the guide/docs-env-vars-missing branch September 3, 2026 01:45
@github-actions

github-actions Bot commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

Thank you for your contribution! Your PR has been merged.

Check out what's new:

Stay connected: Slack #kubestellar-dev | Multi-Cluster Survey

@kubestellar-hive kubestellar-hive Bot mentioned this pull request Sep 3, 2026
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@clubanderson clubanderson clubanderson approved these changes

Assignees

@clubanderson clubanderson

Labels

copilot dco-signoff: yes Indicates the PR's author has signed the DCO. hold lgtm Indicates that a PR is ready to be merged. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[guide] env-vars.md missing 7 operator-facing variables: workspace-cleanup tuning, advisory issue-activity thresholds, hub public-origin chain

1 participant

@clubanderson